Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GitHub issue templates for bug reports and feature requests #1478

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

ofir-frd
Copy link
Collaborator

@ofir-frd ofir-frd commented Jan 23, 2025

PR Type

Documentation


Description

  • Added a bug report template to streamline issue reporting.

  • Introduced a feature request template for new proposals.

  • Configured issue template settings and added contact links.


Changes walkthrough 📝

Relevant files
Documentation
bug-report.yml
Added a structured bug report template                                     

.github/ISSUE_TEMPLATE/bug-report.yml

  • Created a bug report template for structured issue reporting.
  • Included fields for system info, reproduction steps, and expected
    behavior.
  • Added checkboxes for task and script information.
  • +56/-0   
    config.yml
    Configured issue template settings and contact links         

    .github/ISSUE_TEMPLATE/config.yml

  • Enabled blank issues in the configuration.
  • Added contact links for Discord, documentation, and main site.
  • +12/-0   
    feature-request.yml
    Added a structured feature request template                           

    .github/ISSUE_TEMPLATE/feature-request.yml

  • Created a feature request template for new proposals.
  • Included fields for feature description, motivation, and contribution.
  • +31/-0   

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • @ofir-frd
    Copy link
    Collaborator Author

    /describe
    --pr_description.generate_ai_title=true
    --pr_description.final_update_message=true

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🏅 Score: 95
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Documentation Clarity

    The placeholder text for reproduction steps is redundant as it repeats information already present in the description field above it

    placeholder: |
      Providing a minimal, reproducible reproduction using a publicly available model significantly increase the chances of a fix in a timely manner.

    @qodo-merge-pro qodo-merge-pro bot changed the title Of/issue template Add GitHub issue templates for bug reports and feature requests Jan 23, 2025
    Copy link
    Contributor

    PR Description updated to latest commit (2f69c89)

    Copy link
    Contributor

    qodo-merge-pro bot commented Jan 23, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Add version tracking for debugging

    Add a field to capture the PR-Agent version being used, as this is critical for
    debugging issues and ensuring version compatibility.

    .github/ISSUE_TEMPLATE/bug-report.yml [5-11]

     - type: textarea
       id: system-info
       attributes:
         label: System Info
    -    description: Please share your system info with us.
    +    description: Please share your system info with us, including PR-Agent version.
         render: shell
    -    placeholder: platform, python version, model used, etc...
    +    placeholder: PR-Agent version, platform, python version, model used, etc...
    Suggestion importance[1-10]: 8

    Why: Including PR-Agent version in system info is crucial for debugging issues and providing appropriate support, as different versions may have different behaviors or known issues.

    8
    Distinguish between deployment environments

    Add a field for users to specify if they're using the tool in a CI/CD environment vs
    local development, as behavior can differ significantly.

    .github/ISSUE_TEMPLATE/bug-report.yml [15-22]

     - type: checkboxes
       id: information-scripts-examples
       attributes:
         label: Information
         description: 'The problem arises when using:'
         options:
           - label: "The official example scripts"
           - label: "My own modified scripts"
    +      - label: "Running in CI/CD environment"
    +      - label: "Running locally"
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Adding environment context (CI/CD vs local) is valuable for troubleshooting as issues may manifest differently in different environments, helping maintainers reproduce and fix problems more effectively.

    7

    @ofir-frd ofir-frd requested review from hussam789 and mrT23 January 23, 2025 11:40
    Co-authored-by: qodo-merge-pro[bot] <151058649+qodo-merge-pro[bot]@users.noreply.github.com>
    Co-authored-by: qodo-merge-pro[bot] <151058649+qodo-merge-pro[bot]@users.noreply.github.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants